ExitUnion
PackageAxial
Represents the final outcome of a workflow execution.
Specification
Kind
Union
Members
10
Examples
0
mapSignature
Exit.map mapper exit
bindSignature
Exit.bind binder exit
mapErrorSignature
Exit.mapError mapper exit
mapBothSignature
Exit.mapBoth onSuccess onFailure exit
fromResultSignature
Exit.fromResult result
Summary
| Name | Signature | Synopsis |
|---|---|---|
| Union cases | ||
| IsFailure | this.IsFailure | No description available. |
| IsSuccess | this.IsSuccess | No description available. |
| Success | Success 'value | The workflow completed successfully. |
| Failure | Failure Cause<'error> | The workflow failed due to a specific cause. |
| Operations | ||
| map | Exit.map mapper exit | Transforms the success value of an exit outcome using the provided function. |
| bind | Exit.bind binder exit | Binds the success value of an exit outcome to a function that returns a new exit outcome. |
| mapError | Exit.mapError mapper exit | Transforms the error value of a failed exit outcome using the provided function. |
| mapBoth | Exit.mapBoth onSuccess onFailure exit | Transforms both success and failure outcomes of an exit using the provided functions. |
| fromResult | Exit.fromResult result | Creates an exit outcome from a standard F# Result. |
| toResult | Exit.toResult exit | Converts an exit outcome to a standard F# Result. |
Union cases
kind:member
Operations
kind:member
kind:member
Binds the success value of an exit outcome to a function that returns a new exit outcome.
Parameters
| Name | Type | Description |
|---|---|---|
| binder | 'v -> Exit<'w, 'e> | The function that takes a success value and returns a new exit outcome. |
| exit | Exit<'v, 'e> | The exit outcome to bind. |
Returns
Exit<'w, 'e>
kind:member
kind:member
Transforms both success and failure outcomes of an exit using the provided functions.
Parameters
| Name | Type | Description |
|---|---|---|
| onSuccess | 'v -> 'w | The function to transform the success value. |
| onFailure | Cause<'e> -> Cause<'f> | The function to transform the failure cause. |
| exit | Exit<'v, 'e> | The exit outcome to transform. |
Returns
Exit<'w, 'f>
kind:member